These files are not meant to be edited by hand.
If you need to make modifications, the respective files should be changed within the repository's top-level src directory. Running jake LKG will then appropriately update the files in this directory.
An element inferred from the string index signature of the JSX.IntrinsicElements interface
An element from a named property of the JSX.IntrinsicElements interface
Element resolution failed
An element backed by a class, class-like, or function value
Gives lexical classifications of tokens on a line without any syntactic context. For instance, a token consisting of the text 'string' can be either an identifier named 'string' or the keyword 'string', however, because this classifier is not aware, it relies on certain heuristics to give acceptable results. For classifications where speed trumps accuracy, this function is preferable; however, for true accuracy, the syntactic classifier is ideal. In fact, in certain editing scenarios, combining the lexical, syntactic, and semantic classifiers may issue the best user experience.
The text of a line to classify.
The state of the lexical classifier at the end of the previous line.
Whether the client is not using a syntactic classifier. If there is no syntactic classifier (syntacticClassifierAbsent=true), certain heuristics may be used in its place; however, if there is a syntactic classifier (syntacticClassifierAbsent=false), certain classifications which may be incorrectly categorized will be given back as Identifiers in order to allow the syntactic classifier to subsume the classification.
A linked list of formatted diagnostic messages to be used as part of a multiline message. It is built from the bottom up, leaving the head to be the "main" diagnostic. While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage, the difference is that messages are all preformatted in DMC.
The document registry represents a store of SourceFile objects that can be shared between multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST) of files in the context. SourceFile objects account for most of the memory usage by the language service. Sharing the same DocumentRegistry instance between different instances of LanguageService allow for more efficient memory utilization since all projects will share at least the library file (lib.d.ts).
A more advanced use of the document registry is to serialize sourceFile objects to disk and re-hydrate them when needed.
To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it to all subsequent createLanguageService calls.
Request a stored SourceFile with a given fileName and compilationSettings. The first call to acquire will call createLanguageServiceSourceFile to generate the SourceFile if was not found in the registry.
The name of the file requested
Some compilation settings like target affects the shape of a the resulting SourceFile. This allows the DocumentRegistry to store multiple copies of the same file for different compilation settings.
Informs the DocumentRegistry that a file is not needed any longer.
Note: It is not allowed to call release on a SourceFile that was not acquired from this registry originally.
The name of the file to be released
The compilation settings used to acquire the file
Request an updated version of an already existing SourceFile with a given fileName and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile to get an updated SourceFile.
The name of the file requested
Some compilation settings like target affects the shape of a the resulting SourceFile. This allows the DocumentRegistry to store multiple copies of the same file for different compilation settings.
Text of the file.
Current version of the file.
Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclaration. Examples:
Represents an immutable snapshot of a script at a specified time.Once acquired, the snapshot is observably immutable. i.e. the same calls with the same parameters will return the same values.
Releases all resources held by this script snapshot
Gets the TextChangeRange that describe how the text changed between this text and an older version. This information is used by the incremental parser to determine what sections of the script need to be re-parsed. 'undefined' can be returned if the change range cannot be determined. However, in that case, incremental parsing will not happen and the entire document will be re - parsed.
Gets the length of this script snapshot.
Gets a portion of the script snapshot specified by [start, end).
Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.
Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns the index of the first occurrence of a value in an array.
The value to locate in the array.
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Adds all the elements of an array separated by the specified separator string.
A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns the index of the last occurrence of a specified value in an array.
The value to locate in the array.
The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Removes the last element from an array and returns it.
Appends new elements to an array, and returns the new length of the array.
New elements of the Array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Reverses the elements in an Array.
Removes the first element from an array and returns it.
Returns a section of an array.
The beginning of the specified portion of the array.
The end of the specified portion of the array.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
The zero-based location in the array from which to start removing elements.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
The zero-based location in the array from which to start removing elements.
The number of elements to remove.
Elements to insert into the array in place of the deleted elements.
Returns a string representation of an array.
Inserts new elements at the start of an array.
Elements to insert at the start of the Array.
Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.
Combines two or more arrays.
Additional items to add to the end of array1.
Combines two or more arrays.
Additional items to add to the end of array1.
Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns the index of the first occurrence of a value in an array.
The value to locate in the array.
The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Adds all the elements of an array separated by the specified separator string.
A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns the index of the last occurrence of a specified value in an array.
The value to locate in the array.
The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Calls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Removes the last element from an array and returns it.
Appends new elements to an array, and returns the new length of the array.
New elements of the Array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Reverses the elements in an Array.
Removes the first element from an array and returns it.
Returns a section of an array.
The beginning of the specified portion of the array.
The end of the specified portion of the array.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Sorts an array.
The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
The zero-based location in the array from which to start removing elements.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
The zero-based location in the array from which to start removing elements.
The number of elements to remove.
Elements to insert into the array in place of the deleted elements.
Returns a string representation of an array.
Inserts new elements at the start of an array.
Elements to insert at the start of the Array.
Whether or not this region should be automatically collapsed when the 'Collapse to Definitions' command is invoked.
The text to display in the editor for the collapsed region.
The span of the document to display when the user hovers over the collapsed span.
The span of the document to actually collapse.
Emits the JavaScript and declaration files. If targetSourceFile is not specified, then the JavaScript and declaration files will be produced for all the files in this program. If targetSourceFile is specified, then only the JavaScript and declaration for that specific file will be generated.
If writeFile is not specified then the writeFile callback from the compiler host will be used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter will be invoked when writing the JavaScript and declaration files.
Get a list of root file names that were passed to a 'createProgram'
Get a list of files in the program
Gets a type checker that can be used to semantically analyze source fils in the program.
Represents a single signature to show in signature help. The id is used for subsequent calls into the language service to ask questions about the signature help item in the context of any documents that have been updated. i.e. after an edit has happened, while signature help is still active, the host can ask important questions like 'what parameter is the user currently contained within?'.
Represents a set of signature help items, and the preferred item that should be selected.
lib.d.ts should have a reference comment like
///
If any other file has this comment, it signals not to include lib.d.ts because this containing file is intended to act as a default library.
Column number in the .js file.
Line number in the .js file.
Optional name (index into names array) associated with this span.
Column number in the .ts file.
.ts file (index into sources array) associated with this span
Line number in the .ts file.
The position in newText the caret should point to after the insertion.
The version of the language service API
Called to merge all the changes that occurred across several versions of a script snapshot into a single change. i.e. if a user keeps making successive edits to a script we will have a text change from V1 to V2, V2 to V3, ..., Vn.
This function will then merge those changes into a single change range valid between V1 and Vn.
Get the path of the default library files (lib.d.ts) as distributed with the typescript node package. The functionality is not supported if the ts module is consumed outside of a node module.
Optionally, get the shebang
Parse the text of the tsconfig.json file
The path to the config file
The text of the config file
Parse the contents of a config file (tsconfig.json).
The contents of the config file to parse
Instance of ParseConfigHost used to enumerate files in folder.
A root directory to resolve relative path entries in the config file to. e.g. outDir
Read tsconfig.json file
The path to the config file
Informs the DocumentRegistry that a file is not needed any longer.
Note: It is not allowed to call release on a SourceFile that was not acquired from this registry originally.
The name of the file to be released
The compilation settings used to acquire the file
Request an updated version of an already existing SourceFile with a given fileName and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile to get an updated SourceFile.
The name of the file requested
Some compilation settings like target affects the shape of a the resulting SourceFile. This allows the DocumentRegistry to store multiple copies of the same file for different compilation settings.
Text of the file.
Current version of the file.
result of transpilation action
the transpiled code, if transpilation was not halted
diagnostics produced by Typescript or the visitors
did the transpilation fail
a raw sourcemap object representing all changes made from the supplied source to the transpiled code (visitors and typescript alike)
single unit of transpilation logic
predicate defining whether this visitor should operate on this node
typescript AST node
perform visitor logic on given node
typescript AST node for which filter(node) returnes true
transpilation actions handler for the current visit
a transpilation actions API supplied to Visitor at visit time
was the transpilation declared as failed by any previous visitor
insert text at given position
position in code at which to insert line.
text to insert
add a text line at given position
position in code at which to insert line.
line to insert
replace a piece of text in the code with a given new text
position in code of the first character to replace
position in code of the last character to replace. has to be greater or equal to the start param.
replacement string to insert instead of original state
report transpilation diagnostics
typescript AST node that relats to this diagnostic
severity of the diagnostic to report (could be error, warning or message)
txt of the diagnostic
if true, the transpilation is declared as failed
Expression to test for truthiness.
Message to display on error.
Expression to test for truthiness.
Message to display on error.
Provides a way to extend the internals of Chai
Specify execution on the leading edge of the timeout.
The maximum time func is allowed to be delayed before it's called.
Specify execution on the trailing edge of the timeout.
Enables explicit method chaining on the wrapper object.
The wrapper object.
Function name
_.pluck style callback
The number of elements to return.
The function called per element.
"_.pluck" style callback value
"_.where" style callback value
The number of elements to return.
The function called per element.
"_.pluck" style callback value
"_.where" style callback value
see _.isNative
see _.isNull
see _.isNumber
see _.isObject
see _.isPlainObject
see _.isRegExp
see _.isString
see _.isTypedArray
see _.isUndefined
_.pluck style callback
_.pluck style callback
_.where style callback
_.pluck style callback
_.where style callback
_.pluck style callback
_.where style callback
_.pluck style callback
_.pluck style callback
_.where style callback
Sorts by all the given arguments, using either ListIterator, pluckValue, or whereValue foramts
The rules by which to sort
_.property callback shorthand.
The number of elements to return.
Takes the first items based on a predicate
The function called per element.
Takes the first items based on a predicate
Uses a _.property style callback to return the property value of the given element
Takes the first items based on a predicate
Uses a _.matches style callback to return the first elements that match the given value
Produces the toString result of the wrapped value.
Returns the string result.
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
Executes the chained sequence to extract the unwrapped value.
Returns the resolved unwrapped value.
Function name
_.pluck style callback
The number of elements to return.
The function called per element.
"_.pluck" style callback value
"_.where" style callback value
The number of elements to return.
The function called per element.
"_.pluck" style callback value
"_.where" style callback value
_.pluck style callback
_.pluck style callback
_.where style callback
_.pluck style callback
_.where style callback
_.pluck style callback
_.where style callback
_.pluck style callback
_.pluck style callback
_.where style callback
Sorts by all the given arguments, using either ListIterator, pluckValue, or whereValue foramts
The rules by which to sort
_.property callback shorthand.
The number of elements to return.
Takes the first items based on a predicate
The function called per element.
Takes the first items based on a predicate
Uses a _.property style callback to return the property value of the given element
Takes the first items based on a predicate
Uses a _.matches style callback to return the first elements that match the given value
Produces the toString result of the wrapped value.
Returns the string result.
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
Executes the chained sequence to extract the unwrapped value.
Returns the resolved unwrapped value.
Enables explicit method chaining on the wrapper object.
The wrapper object.
The function called per iteration.
The this binding of callback.
see _.isNative
see _.isNull
see _.isNumber
see _.isObject
see _.isPlainObject
see _.isRegExp
see _.isString
see _.isTypedArray
see _.isUndefined
_.property callback shorthand.
Produces the toString result of the wrapped value.
Returns the string result.
Executes the chained sequence to extract the unwrapped value.
Returns the resolved unwrapped value.
Creates a lodash object which wraps the given value to enable intuitive method chaining.
In addition to Lo-Dash methods, wrappers also have the following Array methods: concat, join, pop, push, reverse, shift, slice, sort, splice, and unshift
Chaining is supported in custom builds as long as the value method is implicitly or explicitly included in the build.
The chainable wrapper functions are: after, assign, bind, bindAll, bindKey, chain, chunk, compact, compose, concat, countBy, createCallback, curry, debounce, defaults, defer, delay, difference, filter, flatten, forEach, forEachRight, forIn, forInRight, forOwn, forOwnRight, functions, groupBy, indexBy, initial, intersection, invert, invoke, keys, map, max, memoize, merge, min, object, omit, once, pairs, partial, partialRight, pick, pluck, pull, push, range, reject, remove, rest, reverse, sample, shuffle, slice, sort, sortBy, splice, tap, throttle, times, toArray, transform, union, uniq, unshift, unzip, values, where, without, wrap, and zip
The non-chainable wrapper functions are: clone, cloneDeep, contains, escape, every, find, findIndex, findKey, findLast, findLastIndex, findLastKey, has, identity, indexOf, isArguments, isArray, isBoolean, isDate, isElement, isEmpty, isEqual, isFinite, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isRegExp, isString, isUndefined, join, lastIndexOf, mixin, noConflict, parseInt, pop, random, reduce, reduceRight, result, shift, size, some, sortedIndex, runInContext, template, unescape, uniqueId, and value
The wrapper functions first and last return wrapped values when n is provided, otherwise they return unwrapped values.
Explicit chaining can be enabled by using the _.chain method.
Arrays Date Functions Lang Math Number Object String Utility *
Arrays Date Functions Lang Math Number Object String Utility *
Arrays Date Functions Lang Math Number Object String Utility *
Arrays Date Functions Lang Math Number Object String Utility *
Arrays Date Functions Lang Math Number Object String Utility *
Arrays Date Functions Lang Math Number Object String Utility *
The semantic version number.
An object used to flag environments features.
By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.
Adds two numbers.
The first number to add.
The second number to add.
Returns the sum.
Creates a function that executes func, with the this binding and arguments of the created function, only after being called n times.
The number of times the function must be called before func is executed.
The function to restrict.
The new restricted function.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
Creates a function that accepts up to n arguments ignoring any additional arguments.
The function to cap arguments for.
The arity cap.
Enables use as a callback for functions like _.map.
Returns the new function.
Assigns own enumerable properties of source object(s) to the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback is provided it will be executed to produce the assigned values. The callback is bound to thisArg and invoked with two arguments; (objectValue, sourceValue).
The destination object.
The function to customize merging properties.
The this binding of callback.
The destination object.
Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.
The collection to iterate over.
The indexes of collection to retrieve, specified as individual indexes or arrays of indexes.
A new array of elements corresponding to the provided indexes.
Attempts to invoke func, returning either the result or the caught error object. Any additional arguments are provided to func when it’s invoked.
The function to attempt.
Returns the func result or error object.
Creates a function that invokes func, with the this binding and arguments of the created function, while it is called less than n times. Subsequent calls to the created function return the result of the last func invocation.
The number of calls at which func is no longer invoked.
The function to restrict.
Returns the new restricted function.
Creates a function that, when called, invokes func with the this binding of thisArg and prepends any additional bind arguments to those provided to the bound function.
The function to bind.
The this binding of func.
Arguments to be partially applied.
The new bound function.
Binds methods of an object to the object itself, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided all the function properties of object will be bound.
The object to bind and assign the bound methods to.
The object method names to bind, specified as individual method names or arrays of method names.
object
Creates a function that, when called, invokes the method at object[key] and prepends any additional bindKey arguments to those provided to the bound function. This method differs from _.bind by allowing bound functions to reference methods that will be redefined or don't yet exist. See http://michaux.ca/articles/lazy-function-definition-pattern.
The object the method belongs to.
The key of the method.
Arguments to be partially applied.
The new bound function.
Converts string to camel case.
The string to convert.
Returns the camel cased string.
Calculates n rounded up to precision.
The number to round up.
The precision to round up to.
Returns the rounded up number.
Creates a lodash object that wraps the given value with explicit method chaining enabled.
The value to wrap.
The wrapper object.
Creates an array of elements split into groups the length of size. If collection can't be split evenly, the final chunk will be the remaining elements.
The array to process.
The length of each chunk.
Returns the new array containing chunks.
Creates a clone of value. If isDeep is true nested objects are cloned, otherwise they are assigned by reference. If customizer is provided it’s invoked to produce the cloned values. If customizer returns undefined cloning is handled by the method instead. The customizer is bound to thisArg and invoked with up to three argument; (value [, index|key, object]). Note: This method is loosely based on the structured clone algorithm. The enumerable properties of arguments objects and objects created by constructors other than Object are cloned to plain Object objects. An empty object is returned for uncloneable values such as functions, DOM nodes, Maps, Sets, and WeakMaps.
The value to clone.
Specify a deep clone.
The function to customize cloning values.
The this binding of customizer.
Returns the cloned value.
Creates a deep clone of value. If customizer is provided it’s invoked to produce the cloned values. If customizer returns undefined cloning is handled by the method instead. The customizer is bound to thisArg and invoked with up to three argument; (value [, index|key, object]). Note: This method is loosely based on the structured clone algorithm. The enumerable properties of arguments objects and objects created by constructors other than Object are cloned to plain Object objects. An empty object is returned for uncloneable values such as functions, DOM nodes, Maps, Sets, and WeakMaps.
The value to deep clone.
The function to customize cloning values.
The this binding of customizer.
Returns the deep cloned value.
Returns a copy of the array with all falsy values removed. In JavaScript, false, null, 0, "", undefined and NaN are all falsy.
Array to compact.
(Array) Returns a new array of filtered values.
Creates a function that returns value.
The value to return from the new function.
Returns the new function.
Checks if a given value is present in a collection using strict equality for comparisons, i.e. ===. If fromIndex is negative, it is used as the offset from the end of the collection.
The collection to iterate over.
The value to check for.
The index to search from.
True if the target element is found, else false.
The dictionary to iterate over.
The value in the dictionary to search for.
the string to search
the string to search for
Creates an object composed of keys generated from the results of running each element of collection through the callback. The corresponding value of each key is the number of times the key was returned by the callback. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
Returns the composed aggregate object.
Function name
Function name
Function name
Function name
Function name
Creates an object that inherits from the given prototype object. If a properties object is provided its own enumerable properties are assigned to the created object.
The object to inherit from.
The properties to assign to the object.
Returns the new object.
Produces a callback bound to an optional thisArg. If func is a property name the created callback will return the property value for a given element. If func is an object the created callback will return true for elements that contain the equivalent object properties, otherwise it will return false.
The value to convert to a callback.
The this binding of the created callback.
The number of arguments the callback accepts.
A callback function.
Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.
The function to curry.
The arity of func.
Returns the new curried function.
This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.
The function to curry.
The arity of func.
Returns the new curried function.
Creates a function that will delay the execution of func until after wait milliseconds have elapsed since the last time it was invoked. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function will return the result of the last func call.
Note: If leading and trailing options are true func will be called on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.
The function to debounce.
The number of milliseconds to delay.
The options object.
The new debounced function.
Deburrs string by converting latin-1 supplementary letters to basic latin letters and removing combining diacritical marks.
The string to deburr.
Returns the deburred string.
Assigns own enumerable properties of source object(s) to the destination object for all destination properties that resolve to undefined. Once a property is set, additional defaults of the same property will be ignored.
The destination object.
The source objects.
The destination object.
This method is like _.defaults except that it recursively assigns default properties.
The destination object.
The source objects.
Returns object.
Defers executing the func function until the current call stack has cleared. Additional arguments will be provided to func when it is invoked.
The function to defer.
Arguments to invoke the function with.
The timer id.
Executes the func function after wait milliseconds. Additional arguments will be provided to func when it is invoked.
The function to delay.
The number of milliseconds to delay execution.
Arguments to invoke the function with.
The timer id.
Alias of _.find
Alias of _.find
Alias of _.find
Alias of _.find
Alias of _.find
Alias of _.find
Creates an array excluding all values of the provided arrays using strict equality for comparisons , i.e. ===.
The array to process
The arrays of values to exclude.
Returns a new array of filtered values.
The object to iterate over
The function called per iteration.
The this binding of callback.
The object to iterate over
The function called per iteration.
The this binding of callback.
Checks if string ends with the given target string.
The string to search.
The string to search for.
The position to search from.
Returns true if string ends with target, else false.
Converts the characters "&", "<", ">", '"', "'", and "`", in string to their corresponding HTML entities.
The string to escape.
Returns the escaped string.
Escapes the RegExp special characters "\", "/", "^", "$", ".", "|", "?", "*", "+", "(", ")", "[", "]", "{" and "}" in string.
The string to escape.
Returns the escaped string.
Checks if the given callback returns truey value for all elements of a collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
True if all elements passed the callback check, else false.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
Fills elements of array with value from start up to, but not including, end.
Note: This method mutates array.
(Array): The array to fill.
(*): The value to fill array with.
(Array): Returns array.
Iterates over elements of a collection, returning an array of all elements the identity function returns truey for.
The collection to iterate over.
Returns a new array of elements that passed the callback check.
Iterates over elements of a collection, returning an array of all elements the callback returns truey for. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
Returns a new array of elements that passed the callback check.
_.pluck style callback
_.pluck style callback
_.pluck style callback
Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).
If a property name is provided for predicate the created _.property style callback returns the property value of the given element.
If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.
If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.
Searches for a value in this list.
The function called per iteration.
The this binding of callback.
The found element, else undefined.
This method is like _.find except that it returns the index of the first element that passes the callback check, instead of the element itself.
The array to search.
The function called per iteration. If a property name or object is provided it will be used to create a ".pluck" or ".where" style callback, respectively.
The this binding of callback.
Returns the index of the found element, else -1.
This method is like _.findIndex except that it returns the key of the first element that passes the callback check, instead of the element itself.
The object to search.
The function called per iteration.
The this binding of callback.
The key of the found element, else undefined.
_.pluck style callback
_.where style callback
This method is like _.find except that it iterates over elements of a collection from right to left.
Searches for a value in this list.
The function called per iteration.
The this binding of callback.
The found element, else undefined.
This method is like _.findIndex except that it iterates over elements of a collection from right to left.
The array to search.
The function called per iteration. If a property name or object is provided it will be used to create a ".pluck" or ".where" style callback, respectively.
The this binding of callback.
Returns the index of the found element, else -1.
This method is like _.findKey except that it iterates over elements of a collection in the opposite order.
The object to search.
The function called per iteration.
The this binding of callback.
The key of the found element, else undefined.
_.pluck style callback
_.where style callback
Gets the first element or first n elements of an array. If a callback is provided elements at the beginning of the array are returned as long as the callback returns truey. The callback is bound to thisArg and invoked with three arguments; (value, index, array).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return ] true for elements that have the properties of the given object, else false.
Retrieves the first element of this array.
Returns the first element of array.
The number of elements to return.
The number of elements to return.
The function called per element.
The function called per element.
"_.pluck" style callback value
"_.pluck" style callback value
"_.where" style callback value
"_.where" style callback value
Flattens a nested array a single level.
.flatten(x) is equivalent to .flatten(x, false);
The array to flatten.
array flattened.
Flattens a nested array. If isDeep is true the array is recursively flattened, otherwise it is only flattened a single level.
If you know whether or not this should be recursively at compile time, you typically want to use a
version without a boolean parameter (i.e. _.flatten(x) or _.flattenDeep(x)).
The array to flatten.
array flattened.
Recursively flattens a nested array.
.flattenDeep(x) is equivalent to .flatten(x, true);
The array to flatten
array recursively flattened
Calculates n rounded down to precision.
The number to round down.
The precision to round down to.
Returns the rounded down number.
Creates a function that returns the result of invoking the provided functions with the this binding of the created function, where each successive invocation is supplied the return value of the previous.
Functions to invoke.
Returns the new function.
This method is like _.flow except that it creates a function that invokes the provided functions from right to left.
Functions to invoke.
Returns the new function.
Iterates over elements of a collection, executing the callback for each element. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection). Callbacks may exit iteration early by explicitly returning false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
This method is like _.forEach except that it iterates over elements of a collection from right to left.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
Iterates over own and inherited enumerable properties of an object, executing the callback for each property. The callback is bound to thisArg and invoked with three arguments; (value, key, object). Callbacks may exit iteration early by explicitly returning false.
The object to iterate over.
The function called per iteration.
The this binding of callback.
object
This method is like _.forIn except that it iterates over elements of a collection in the opposite order.
The object to iterate over.
The function called per iteration.
The this binding of callback.
object
Iterates over own enumerable properties of an object, executing the callback for each property. The callback is bound to thisArg and invoked with three arguments; (value, key, object). Callbacks may exit iteration early by explicitly returning false.
The object to iterate over.
The function called per iteration.
The this binding of callback.
object
This method is like _.forOwn except that it iterates over elements of a collection in the opposite order.
The object to iterate over.
The function called per iteration.
The this binding of callback.
object
Creates a sorted array of property names of all enumerable properties, own and inherited, of object that have function values.
The object to inspect.
An array of property names that have function values.
Gets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.
The object to query.
The path of the property to get.
The value returned if the resolved value is undefined.
Returns the resolved value.
Creates an object composed of keys generated from the results of running each element of a collection through the callback. The corresponding value of each key is an array of the elements responsible for generating the key. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created ".pluck" style callback will return the property value of the given element. If an object is provided for callback the created ".where" style callback will return true for elements that have the properties of the given object, else false
The collection to iterate over.
The function called per iteration.
The this binding of callback.
Returns the composed aggregate object.
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.pluck style callback
_.where style callback
Checks if value is greater than other.
The value to compare.
The other value to compare.
Returns true if value is greater than other, else false.
Checks if value is greater than or equal to other.
The value to compare.
The other value to compare.
Returns true if value is greater than or equal to other, else false.
Checks if path is a direct property.
The object to query.
The path to check.
True if path is a direct property, else False.
This method returns the first argument provided to it.
Any value.
Returns value.
Checks if n is between start and up to but not including, end. If end is not specified it’s set to start with start then set to 0.
The number to check.
The start of the range.
The end of the range.
Returns true if n is in the range, else false.
Creates an object composed of keys generated from the results of running each element of the collection through the given callback. The corresponding value of each key is the last element responsible for generating the key. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
Returns the composed aggregate object.
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
Gets the index at which the first occurrence of value is found using strict equality for comparisons, i.e. ===. If the array is already sorted providing true for fromIndex will run a faster binary search.
The array to search.
The value to search for.
The index of value within array.
The index to search from
The index to search from
True to perform a binary search on a sorted array.
True to perform a binary search on a sorted array.
Gets all but the last element or last n elements of an array. If a callback is provided elements at the end of the array are excluded from the result as long as the callback returns truey. The callback is bound to thisArg and invoked with three arguments; (value, index, array).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The array to query.
Returns everything but the last n elements of array.
The number of elements to exclude.
The number of elements to exclude.
The function called per element
The function called per element
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
Creates an array of unique values present in all provided arrays using strict equality for comparisons, i.e. ===.
The arrays to inspect.
Returns an array of composite values.
Creates an object composed of the inverted keys and values of the given object.
The object to invert.
The created inverted object.
Invokes the method named by methodName on each element in the collection returning an array of the results of each invoked method. Additional arguments will be provided to each invoked method. If methodName is a function it will be invoked for, and this bound to, each element in the collection.
The collection to iterate over.
The name of the method to invoke.
Arguments to invoke the method with.
Checks if value is classified as an arguments object.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is classified as an Array object.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is classified as a boolean primitive or object.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is classified as a Date object.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is a DOM element.
The value to check.
Returns true if value is a DOM element, else false.
Checks if value is empty. A value is considered empty unless it’s an arguments object, array, string, or jQuery-like collection with a length greater than 0 or an object with own enumerable properties.
The value to inspect.
Returns true if value is empty, else false.
Performs a deep comparison between two values to determine if they are equivalent. If customizer is provided it is invoked to compare values. If customizer returns undefined comparisons are handled by the method instead. The customizer is bound to thisArg and invoked with three arguments: (value, other [, index|key]).
The value to compare.
The other value to compare.
The function to customize value comparisons.
The this binding of customizer.
True if the values are equivalent, else false.
Checks if value is an Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, or URIError object.
The value to check.
Returns true if value is an error object, else false.
Checks if value is a finite primitive number. Note: This method is based on Number.isFinite.
The value to check.
Returns true if value is a finite number, else false.
Checks if value is classified as a Function object.
The value to check.
Returns true if value is correctly classified, else false.
Performs a deep comparison between object and source to determine if object contains equivalent property values. If customizer is provided it’s invoked to compare values. If customizer returns undefined comparisons are handled by the method instead. The customizer is bound to thisArg and invoked with three arguments: (value, other, index|key).
The object to inspect.
The object of property values to match.
The function to customize value comparisons.
The this binding of customizer.
Returns true if object is a match, else false.
Checks if value is NaN. Note: This method is not the same as isNaN which returns true for undefined and other non-numeric values.
The value to check.
Returns true if value is NaN, else false.
Checks if value is a native function.
The value to check.
Checks if value is null.
The value to check.
Returns true if value is null, else false.
Checks if value is classified as a Number primitive or object. Note: To exclude Infinity, -Infinity, and NaN, which are classified as numbers, use the _.isFinite method.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is the language type of Object. (e.g. arrays, functions, objects, regexes, new Number(0), and new String(''))
The value to check.
Returns true if value is an object, else false.
Checks if value is a plain object, that is, an object created by the Object constructor or one with a Prototype of null.
Note: This method assumes objects created by the Object constructor have no inherited enumerable properties.
The value to check.
Returns true if value is a plain object, else false.
Checks if value is classified as a RegExp object.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is classified as a String primitive or object.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is classified as a typed array.
The value to check.
Returns true if value is correctly classified, else false.
Checks if value is undefined.
The value to check.
Returns true if value is undefined, else false.
Converts string to kebab case.
The string to convert.
Returns the kebab cased string.
Creates an array composed of the own enumerable property names of an object.
The object to inspect.
An array of property names.
Creates an array of the own and inherited enumerable property names of object.
The object to query.
An array of property names.
Gets the last element of an array.
The array to query.
Returns the last element of array.
Gets the index at which the last occurrence of value is found using strict equality for comparisons, i.e. ===. If fromIndex is negative, it is used as the offset from the end of the collection.
The array to search.
The value to search for.
The index to search from.
The index of the matched value or -1.
Checks if value is less than other.
The value to compare.
The other value to compare.
Returns true if value is less than other, else false.
Checks if value is less than or equal to other.
The value to compare.
The other value to compare.
Returns true if value is less than or equal to other, else false.
Creates an array of values by running each element in the collection through the callback. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The mapped array result.
The object to iterate over.
The function called per iteration.
this object in iterator, optional.
The mapped object result.
_.pluck style callback
_.pluck style callback
Creates an object with the same keys as object and values generated by running each own enumerable property of object through iteratee. The iteratee function is bound to thisArg and invoked with three arguments: (value, key, object).
If a property name is provided iteratee the created "_.property" style callback returns the property value of the given element.
If a value is also provided for thisArg the creted "_.matchesProperty" style callback returns true for elements that have a matching property value, else false;.
If an object is provided for iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.
Returns the new mapped object.
Retrieves the maximum value of a collection. If the collection is empty or falsey -Infinity is returned. If a callback is provided it will be executed for each value in the collection to generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked with three arguments; (value, index, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
Returns the maximum value.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with the this binding of the memoized function.
The function to have its output memoized.
The function to resolve the cache key.
Returns the new memoizing function.
Recursively merges own enumerable properties of the source object(s), that don't resolve to undefined into the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback is provided it will be executed to produce the merged values of the destination and source properties. If the callback returns undefined merging will be handled by the method instead. The callback is bound to thisArg and invoked with two arguments; (objectValue, sourceValue).
The destination object.
The function to customize merging properties.
The this binding of callback.
The destination object.
Creates a function that invokes the method at path on a given object. Any additional arguments are provided to the invoked method.
The path of the method to invoke.
The arguments to invoke the method with.
Returns the new function.
The opposite of _.method; this method creates a function that invokes the method at a given path on object. Any additional arguments are provided to the invoked method.
The object to query.
The arguments to invoke the method with.
Returns the new function.
Retrieves the minimum value of a collection. If the collection is empty or falsey Infinity is returned. If a callback is provided it will be executed for each value in the collection to generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked with three arguments; (value, index, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
Returns the maximum value.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
Adds function properties of a source object to the lodash function and chainable wrapper.
The object of function properties to add to lodash.
Creates a function that runs each argument through a corresponding transform function.
The function to wrap.
The functions to transform arguments, specified as individual functions or arrays of functions.
Returns the new function.
Creates a function that negates the result of the predicate func. The func predicate is invoked with the this binding and arguments of the created function.
The predicate to negate.
Returns the new function.
Reverts the '_' variable to its previous value and returns a reference to the lodash function.
The lodash function.
A no-operation function that returns undefined regardless of the arguments it receives.
undefined
Gets the number of milliseconds that have elapsed since the Unix epoch (1 January 1970 00:00:00 UTC).
The number of milliseconds.
Creates a shallow clone of object excluding the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback is provided it will be executed for each property of object omitting the properties the callback returns truey for. The callback is bound to thisArg and invoked with three arguments; (value, key, object).
The source object.
The properties to omit.
An object without the omitted properties.
Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first call. The func is invoked with the this binding and arguments of the created function.
The function to restrict.
Returns the new restricted function.
The string to pad.
The padding length.
The string used as padding.
Returns the padded string.
Pads string on the left side if it’s shorter than length. Padding characters are truncated if they exceed length.
The string to pad.
The padding length.
The string used as padding.
Returns the padded string.
Pads string on the right side if it’s shorter than length. Padding characters are truncated if they exceed length.
The string to pad.
The padding length.
The string used as padding.
Returns the padded string.
Creates a two dimensional array of an object's key-value pairs, i.e. [[key1, value1], [key2, value2]].
The object to inspect.
Aew array of key-value pairs.
Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used unless value is a hexadecimal, in which case a radix of 16 is used. Note: This method aligns with the ES5 implementation of parseInt.
The string to convert.
The radix to interpret value by.
Returns the converted integer.
Creates a function that, when called, invokes func with any additional partial arguments prepended to those provided to the new function. This method is similar to _.bind except it does not alter the this binding.
The function to partially apply arguments to.
Arguments to be partially applied.
The new partially applied function.
This method is like _.partial except that partial arguments are appended to those provided to the new function.
The function to partially apply arguments to.
Arguments to be partially applied.
The new partially applied function.
Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, while the second of which contains elements predicate returns falsey for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).
If a property name is provided for predicate the created _.property style callback returns the property value of the given element.
If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.
If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of predicate.
Returns the array of grouped elements.
Creates a shallow clone of object composed of the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback is provided it will be executed for each property of object picking the properties the callback returns truey for. The callback is bound to thisArg and invoked with three arguments; (value, key, object).
Object to strip unwanted key/value pairs.
Property names to pick
An object composed of the picked properties.
Retrieves the value of a specified property from all elements in the collection.
The collection to iterate over.
The property to pluck.
A new array of property values.
Creates a function that returns the property value at path on a given object.
The path of the property to get.
Returns the new function.
The opposite of _.property; this method creates a function that returns the property value at a given path on object.
The object to query.
Returns the new function.
Removes all provided values from the given array using strict equality for comparisons, i.e. ===.
The array to modify.
The values to remove.
array.
Removes all provided values from the given array using strict equality for comparisons, i.e. ===.
The array to modify.
The values to remove.
array.
Produces a random number between min and max (inclusive). If only one argument is provided a number between 0 and the given number will be returned. If floating is truey or either min or max are floats a floating-point number will be returned instead of an integer.
The maximum possible value.
Specify returning a floating-point number.
A random number.
The minimum possible value.
A random number between min and max.
Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. If end is not specified it’s set to start with start then set to 0. If end is less than start a zero-length range is created unless a negative step is specified.
The start of the range.
The end of the range.
The value to increment or decrement by.
Returns a new range array.
Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.
The function to rearrange arguments for.
The arranged argument indexes, specified as individual indexes or arrays of indexes.
Returns the new function.
Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If accumulator is not provided the first element of the collection will be used as the initial accumulator value. The callback is bound to thisArg and invoked with four arguments; (accumulator, value, index|key, collection).
The collection to iterate over.
The function called per iteration.
Initial value of the accumulator.
The this binding of callback.
Returns the accumulated value.
This method is like _.reduce except that it iterates over elements of a collection from right to left.
The collection to iterate over.
The function called per iteration.
Initial value of the accumulator.
The this binding of callback.
The accumulated value.
The opposite of _.filter this method returns the elements of a collection that the callback does not return truey for.
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
A new array of elements that failed the callback check.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
Removes all elements from an array that the callback returns truey for and returns an array of removed elements. The callback is bound to thisArg and invoked with three arguments; (value, index, array).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The array to modify.
The function called per iteration.
The this binding of callback.
A new array of removed elements.
_.pluck style callback
_.pluck style callback
The item to remove
Repeats the given string n times.
The string to repeat.
The number of times to repeat the string.
Returns the repeated string.
The opposite of _.initial this method gets all but the first element or first n elements of an array. If a callback function is provided elements at the beginning of the array are excluded from the result as long as the callback returns truey. The callback is bound to thisArg and invoked with three arguments; (value, index, array).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The array to query.
Returns a slice of array.
Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.
The function to apply a rest parameter to.
The start position of the rest parameter.
Returns the new function.
Resolves the value of property on object. If property is a function it will be invoked with the this binding of object and its result returned, else the property value is returned. If object is false then undefined is returned.
The object to query.
The path of the property to resolve.
The value returned if the resolved value is undefined.
The resolved value.
Calculates n rounded to precision.
The number to round.
The precision to round to.
Returns the rounded number.
Create a new lodash function using the given context object.
The context object
The lodash function.
Retrieves a random element or n random elements from a collection.
The collection to sample.
Returns the random sample(s) of collection.
The number of elements to sample.
The number of elements to sample.
The number of elements to sample.
_.pluck style callback
_.pluck style callback
_.pluck style callback
Sets the property value of path on object. If a portion of path does not exist it is created.
The object to augment.
The path of the property to set.
The value to set.
Returns object.
Creates an array of shuffled values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle.
The collection to shuffle.
Returns a new shuffled collection.
Gets the size of the collection by returning collection.length for arrays and array-like objects or the number of own enumerable properties for objects.
The collection to inspect.
collection.length
The object to inspect
The number of own enumerable properties.
The string to inspect
The length of aString
Converts string to snake case.
The string to convert.
Returns the snake cased string.
Checks if the callback returns a truey value for any element of a collection. The function returns as soon as it finds a passing value and does not iterate over the entire collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The collection to iterate over.
The function called per iteration.
The this binding of callback.
True if any element passed the callback check, else false.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
Creates an array of elements, sorted in ascending order by the results of running each element in a collection through the callback. This method performs a stable sort, that is, it will preserve the original sort order of equal elements. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If a value is also provided for thisArg the created "_.matchesProperty" style callback returns true for elements that have a matching property value, else false.
If an object is provided for an iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.
The collection to iterate over.
The this binding of callback.
A new array of sorted elements.
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
Sorts by all the given arguments, using either ListIterator, pluckValue, or whereValue foramts
The rules by which to sort
This method is like "_.sortBy" except that it can sort by multiple iteratees or property names.
If a property name is provided for an iteratee the created "_.property" style callback returns the property value of the given element.
If a value is also provided for thisArg the created "_.matchesProperty" style callback returns true for elements that have a matching property value, else false.
If an object is provided for an iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.
The collection to iterate over.
A new array of sorted elements.
This method is like "_.sortByAll" except that it allows specifying the sort orders of the iteratees to sort by. If orders is unspecified, all values are sorted in ascending order. Otherwise, a value is sorted in ascending order if its corresponding order is "asc", and descending if "desc".
If a property name is provided for an iteratee the created "_.property" style callback returns the property value of the given element.
If an object is provided for an iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.
The collection to iterate over.
A new array of sorted elements.
Uses a binary search to determine the smallest index at which a value should be inserted into a given sorted array in order to maintain the sort order of the array. If a callback is provided it will be executed for value and each element of array to compute their sort ranking. The callback is bound to thisArg and invoked with one argument; (value).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
The sorted list.
The value to determine its index within list.
Iterator to compute the sort ranking of each value, optional.
The index at which value should be inserted into array.
the _.pluck style callback
the _.pluck style callback
Creates a function that invokes func with the this binding of the created function and an array of arguments much like Function#apply.
The function to spread arguments over.
Returns the new function.
Converts string to start case.
The string to convert.
Returns the start cased string.
Checks if string starts with the given target string.
The string to search.
The string to search for.
The position to search from.
Returns true if string starts with target, else false.
Gets the sum of the values in collection.
The collection to iterate over.
Returns the sum.
_.property callback shorthand.
_.property callback shorthand.
_.property callback shorthand.
Takes the first items from an array or list based on a predicate
The array or list of items on which the result set will be based
A predicate function to determine whether a value will be taken. Optional; defaults to identity.
Takes the first items from an array or list based on a predicate
The array or list of items on which the result set will be based
Uses a _.property style callback to return the property value of the given element
Takes the first items from an array or list based on a predicate
The array or list of items on which the result set will be based
Uses a _.matches style callback to return the first elements that match the given value
Invokes interceptor with the value as the first argument and then returns value. The purpose of this method is to "tap into" a method chain in order to perform operations on intermediate results within the chain.
The value to provide to interceptor
The function to invoke.
value
Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is provided it takes precedence over _.templateSettings values.
Note: In the development build _.template utilizes sourceURLs for easier debugging.
For more information on precompiling templates see lodash's custom builds documentation.
For more information on Chrome extension sandboxes see Chrome's extensions documentation.
The template string.
The options object.
Returns the compiled template function.
Creates a function that, when executed, will only call the func function at most once per every wait milliseconds. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function will return the result of the last func call.
Note: If leading and trailing options are true func will be called on the trailing edge of the timeout only if the the throttled function is invoked more than once during the wait timeout.
The function to throttle.
The number of milliseconds to throttle executions to.
The options object.
The new throttled function.
Invokes the iteratee function n times, returning an array of the results of each invocation. The iteratee is bound to thisArg and invoked with one argument; (index).
The number of times to invoke iteratee.
The function invoked per iteration.
The this binding of iteratee.
Returns the array of results.
Converts the collection to an array.
The collection to convert.
The new converted array.
Converts value to a plain object flattening inherited enumerable properties of value to own properties of the plain object.
The value to convert.
Returns the converted plain object.
An alternative to _.reduce this method transforms object to a new accumulator object which is the result of running each of its elements through a callback, with each callback execution potentially mutating the accumulator object. The callback is bound to thisArg and invoked with four arguments; (accumulator, value, key, object). Callbacks may exit iteration early by explicitly returning false.
The collection to iterate over.
The function called per iteration.
The custom accumulator value.
The this binding of callback.
The accumulated value.
Removes leading and trailing whitespace or specified characters from string.
The string to trim.
The characters to trim.
Returns the trimmed string.
Removes leading whitespace or specified characters from string.
The string to trim.
The characters to trim.
Returns the trimmed string.
Removes trailing whitespace or specified characters from string.
The string to trim.
The characters to trim.
Returns the trimmed string.
Truncates string if it’s longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "…".
The string to truncate.
The options object or maximum string length.
Returns the truncated string.
The inverse of _.escape; this method converts the HTML entities &, <, >, ", ', and ` in string to their corresponding characters.
The string to unescape.
Returns the unescaped string.
Creates an array of unique values, in order, of the provided arrays using strict equality for comparisons, i.e. ===.
The arrays to inspect.
Returns an array of composite values.
Creates a duplicate-value-free version of an array using strict equality for comparisons, i.e. ===. If the array is sorted, providing true for isSorted will use a faster algorithm. If a callback is provided each element of array is passed through the callback before uniqueness is computed. The callback is bound to thisArg and invoked with three arguments; (value, index, array).
If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.
If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.
Array to remove duplicates from.
True if array is already sorted, optiona, default = false.
Copy of array where all elements are unique.
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
_.where style callback
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.pluck style callback
_.where style callback
_.where style callback
_.where style callback
_.where style callback
Generates a unique ID. If prefix is provided the ID is appended to it.
The value to prefix the ID with.
Returns the unique ID.
Creates an array of the own enumerable property values of object.
The object to query.
Returns an array of property values.
Creates an array of the own and inherited enumerable property values of object.
The object to query.
Returns the array of property values.
Performs a deep comparison of each element in a collection to the given properties object, returning an array of all elements that have equivalent property values.
The object of property values to filter by.
A new array of elements that have the given properties.
Creates an array excluding all provided values using strict equality for comparisons, i.e. ===.
The array to filter.
The value(s) to exclude.
A new array of filtered values.
Splits string into an array of its words.
The string to inspect.
The pattern to match words.
Returns the words of string.
Creates a function that provides value to the wrapper function as its first argument. Additional arguments provided to the function are appended to those provided to the wrapper function. The wrapper is executed with the this binding of the created function.
The value to wrap.
The wrapper function.
The new function.
Creates an array of unique values that is the symmetric difference of the provided arrays.
The arrays to inspect.
Returns the new array of values.
Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.
Arrays to process.
A new array of grouped elements.
The inverse of _.pairs; this method returns an object composed from arrays of property names and values. Provide either a single two dimensional array, e.g. [[key1, value1], [key2, value2]] or two arrays, one of property names and one of corresponding values.
Returns the new object.
This method is like _.zip except that it accepts an iteratee to specify how grouped values should be combined. The iteratee is bound to thisArg and invoked with four arguments: (accumulator, value, index, group).
Returns the new array of grouped elements.
Produces the toString result of the wrapped value.
Returns the string result.
Executes the chained sequence to extract the unwrapped value.
Returns the resolved unwrapped value.
Enables explicit method chaining on the wrapper object.
The wrapper object.
see _.isNative
see _.isNull
see _.isNumber
see _.isObject
see _.isPlainObject
see _.isRegExp
see _.isString
see _.isTypedArray
see _.isUndefined
Produces the toString result of the wrapped value.
Returns the string result.
Executes the chained sequence to extract the unwrapped value.
Returns the resolved unwrapped value.
Enables explicit method chaining on the wrapper object.
The wrapper object.
see _.isNative
see _.isNull
see _.isNumber
see _.isObject
see _.isPlainObject
see _.isRegExp
see _.isString
see _.isTypedArray
see _.isUndefined
Produces the toString result of the wrapped value.
Returns the string result.
Executes the chained sequence to extract the unwrapped value.
Returns the resolved unwrapped value.
Creates a cache object to store key/value pairs.
Removes key and its value from the cache.
The key of the value to remove.
Returns true if the entry was removed successfully, else false.
Gets the cached value for key.
The key of the value to get.
Returns the cached value.
Checks if a cached value for key exists.
The key of the entry to check.
Returns true if an entry for key exists, else false.
Sets value to key of the cache.
The key of the value to cache.
The value to cache.
Returns the cache object.
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
The object to be used as the this object.
A set of arguments to be passed to the function.
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
An object to which the this keyword can refer inside the new function.
A list of arguments to be passed to the new function.
Calls a method of an object, substituting another object for the current object.
The object to be used as the current object.
A list of arguments to be passed to the method.
An object used to flag environments features.
Detect if an arguments object's Class is resolvable (all but Firefox < 4, IE < 9).
Detect if arguments objects are Object objects (all but Narwhal and Opera < 10.5).
Detect if name or message properties of Error.prototype are enumerable by default. (IE < 9, Safari < 5.1)
Detect if prototype properties are enumerable by default.
Firefox < 3.6, Opera > 9.50 - Opera < 11.60, and Safari < 5.1 (if the prototype or a property on the prototype has been set) incorrectly set the [[Enumerable]] value of a function’s prototype property to true.
Detect if Function#bind exists and is inferred to be fast (all but V8).
Detect if functions can be decompiled by Function#toString (all but PS3 and older Opera mobile browsers & avoided in Windows 8 apps).
Detect if Function#name is supported (all but IE).
Detect if arguments object indexes are non-enumerable (Firefox < 4, IE < 9, PhantomJS, Safari < 5.1).
Detect if properties shadowing those on Object.prototype are non-enumerable.
In IE < 9 an objects own properties, shadowing non-enumerable ones, are made non-enumerable as well (a.k.a the JScript [[DontEnum]] bug).
Detect if own properties are iterated after inherited properties (all but IE < 9).
Detect if Array#shift and Array#splice augment array-like objects correctly.
Firefox < 10, IE compatibility mode, and IE < 9 have buggy Array shift() and splice() functions that fail to remove the last element, value[0], of array-like objects even though the length property is set to 0. The shift() method is buggy in IE 8 compatibility mode, while splice() is buggy regardless of mode in IE < 9 and buggy in compatibility mode in IE 9.
Detect lack of support for accessing string characters by index.
IE < 8 can't access characters by index and IE 8 can only access characters by index on string literals.
By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.
The "escape" delimiter.
The "evaluate" delimiter.
An object to import into the template as local variables.
The "interpolate" delimiter.
Used to reference the data object in the template text.
If you'd like to disable the leading-edge call, pass this as false.
If you'd like to disable the execution on the trailing-edge, pass false.
The maximum string length.
The string to indicate text is omitted.
The separator pattern to truncate to.
String used to indicate the end of the progress bar.
String used to indicate a complete test on the progress bar.
String used to indicate an incomplete test on the progress bar.
String used to indicate the start of the progress bar.
Partial interface for Mocha's Runnable class.
Partial interface for Mocha's Runner class.
Partial interface for Mocha's Suite class.
Partial interface for Mocha's Test class.
Enables growl support.
Runs tests and invokes onComplete() when finished.
Setup mocha with the given options.
*
MODULES *
*
Constant for fs.access(). File is visible to the calling process.
Constant for fs.access(). File can be read by the calling process.
Constant for fs.access(). File can be written by the calling process.
Constant for fs.access(). File can be executed by the calling process.
Tests a user's permissions for the file specified by path.
Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise.
Asynchronous rename.
No arguments other than a possible exception are given to the completion callback.
Synchronous rename
Destroy any sockets that are currently in use by the agent. It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.
Keep sockets around in a pool to be used by other requests in the future. Default = false
When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.
Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.
Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity
Only valid for request obtained from http.Server.
Only valid for response obtained from http.ClientRequest.
Only valid for response obtained from http.ClientRequest.
Only valid for request obtained from http.Server.
Only valid for request obtained from http.Server.
Only valid for response obtained from http.ClientRequest.
Only valid for response obtained from http.ClientRequest.
Only valid for request obtained from http.Server.
Only valid for request obtained from http.Server.
Only valid for response obtained from http.ClientRequest.
Only valid for response obtained from http.ClientRequest.
Only valid for request obtained from http.Server.
A parsed path object generated by path.parse() or consumed by path.format().
The file name including extension (if any) such as 'index.html'
The full directory path such as '/home/user/dir' or 'c:\path\dir'
The file extension (if any) such as '.html'
The file name without extension (if any) such as 'index'
The root of the path such as '/' or 'c:\'
The platform-specific file delimiter. ';' or ':'.
The platform-specific file separator. '\' or '/'.
Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.
the path to evaluate.
optionally, an extension to remove from the result.
Return the directory name of a path. Similar to the Unix dirname command.
the path to evaluate.
Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string
the path to evaluate.
Returns a path string from an object - the opposite of parse().
Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
path to test.
Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
string paths to join.
Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
string paths to join.
Normalize a string path, reducing '..' and '.' parts. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
string path to normalize.
Returns an object from a path string - the opposite of format().
path to evaluate.
Solve the relative path from {from} to {to}. At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.
The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
Starting from leftmost {from} paramter, resolves {to} to an absolute path.
If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.
string paths to join. Non-string arguments are ignored.
*
GLOBAL INTERFACES *
*
Allocates a new buffer containing the given {str}.
String to store in buffer.
encoding to use, optional. Default is 'utf8'
Allocates a new buffer of {size} octets.
count of octets to allocate.
Allocates a new buffer containing the given {array} of octets.
The octets to store.
Allocates a new buffer containing the given {array} of octets.
The octets to store.
Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.
string to test.
encoding used to evaluate (defaults to 'utf8')
Returns a buffer which is the result of concatenating all the buffers in the list together.
If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.
An array of Buffer objects to concatenate
Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.
Returns true if {obj} is a Buffer
object to test.
Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
string to test.
Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
*
Node.js v0.12.0 API *
*
*
GLOBAL *
*
A virtual file format.
Used for relative pathing. Typically where a glob starts.
File contents. Type: Buffer, Stream, or null
Default: process.cwd()
Path history. Has no effect if options.path is passed.
Full path to the file.
The result of an fs.stat call. See fs.Stats for more information.
Used for relative pathing. Typically where a glob starts.
Type: Buffer|Stream|null (Default: null)
Default: process.cwd()
Full path to the file.
Returns path.relative for the file base and file path. Example: var file = new File({ cwd: "/", base: "/test/", path: "/test/file.js" }); console.log(file.relative); // file.js
Returns a new File object with all attributes cloned. Custom attributes are deep-cloned.
Returns a pretty String interpretation of the File. Useful for console.log.
If file.contents is a Buffer, it will write it to the stream. If file.contents is a Stream, it will pipe it to the stream. If file.contents is null, it will do nothing.
If false, the destination stream will not be ended (same as node core).
Generated using TypeDoc
Return code used by getEmitOutput function to indicate status of the function